API docs by Redocly

Point API Docs (0.0.1)

Download OpenAPI specification:Download

API Support: martiendt@gmail.com URL: https://github.com/Redocly/redoc License: MIT

Cross-Origin Resource Sharing

This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with W3C spec. And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.

Authentication

Ex-Module offers two forms of authentication:

  • Local Authentication
  • Json Web Token

Admin

Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.

Read all admin

lorem ipsum

query Parameters
started
required
date
Example: started=2022-02-22T00:00:00.0000Z

filter joined admin

ended
required
date
Example: ended=2022-02-24T00:00:00.0000Z

filter joined admin

timezone
string
Default: "UTC"
Example: timezone=Asia/Jakarta

setup timezone response

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "data": [
    ]
}

Transfer Item

Read all transfer items

query Parameters
join
string
Example: join=form,item,items

multi value, divide with coma (,)

fields
string
Example: fields=transfer_sent.*

multi value, divide with coma (,)

sort_by
string
Default: "name"
Example: sort_by=-form.number

Sort the result by a key

group_by
string
Example: group_by=-form.id

Group the result by a key

object
object
object
limit
integer
Example: limit=10

Data limit

includes
string
Example: includes=form,items.item

multi value, divide with coma (,)

page
integer
Example: page=1

Data page

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "links": {
    },
  • "data": [
    ]
}

Create new transfer item

lorem ipsum

Request Body schema: application/json
increment_group
string
date
date
warehouse_id
integer
warehouse_name
string
to_warehouse_id
integer
to_warehouse_name
string
driver
string
notes
string
Array of objects
request_approval_to
integer
approver_name
string
approver_email
string

Responses

Request samples

Content type
application/json
{
  • "increment_group": "string",
  • "date": null,
  • "warehouse_id": 0,
  • "warehouse_name": "string",
  • "to_warehouse_id": 0,
  • "to_warehouse_name": "string",
  • "driver": "string",
  • "notes": "string",
  • "items": [
    ],
  • "request_approval_to": 0,
  • "approver_name": "string",
  • "approver_email": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Read transfer item

path Parameters
id
required
integer

Transfer Item ID

query Parameters
with_archives
boolean
Default: true
with_origin
boolean
Default: true
includes
string
Example: includes=warehouse;to_warehouse;items.item;form.createdBy;form.requestApprovalTo;form.branch

multi value, divide with coma (;)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update transfer item

path Parameters
id
required
integer

Transfer Item ID

Request Body schema: application/json
id
integer
increment_group
string
date
date
warehouse_id
integer
warehouse_name
string
to_warehouse_id
integer
to_warehouse_name
string
driver
string
notes
string
Array of objects
request_approval_to
integer
approver_name
string
approver_email
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "increment_group": "string",
  • "date": null,
  • "warehouse_id": 0,
  • "warehouse_name": "string",
  • "to_warehouse_id": 0,
  • "to_warehouse_name": "string",
  • "driver": "string",
  • "notes": "string",
  • "items": [
    ],
  • "request_approval_to": 0,
  • "approver_name": "string",
  • "approver_email": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete transfer item

path Parameters
id
required
integer

Transfer Item ID

Request Body schema: application/json
reason
string

Responses

Request samples

Content type
application/json
{
  • "reason": "string"
}

Export transfer items

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "url": "string"
}

Receive Item

Read all receive items

query Parameters
join
string
Example: join=form,item,items

multi value, divide with coma (,)

fields
string
Example: fields=transfer_receive.*

multi value, divide with coma (,)

sort_by
string
Default: "name"
Example: sort_by=-form.number

Sort the result by a key

group_by
string
Example: group_by=-form.id

Group the result by a key

object
object
object
limit
integer
Example: limit=10

Data limit

includes
string
Example: includes=form,items.item,from_warehouse,warehouse,transfer_item.form,transfer_item.items

multi value, divide with coma (,)

page
integer
Example: page=1

Data page

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "links": {
    },
  • "data": [
    ]
}

Create new receive item

Request Body schema: application/json
increment_group
string
date
date
warehouse_id
integer\
from_warehouse_id
integer
notes
string
Array of objects
request_approval_to
integer
approver_name
string
approver_email
string
transfer_item_id
integer

Responses

Request samples

Content type
application/json
{
  • "increment_group": "string",
  • "date": null,
  • "warehouse_id": null,
  • "from_warehouse_id": 0,
  • "notes": "string",
  • "items": [
    ],
  • "request_approval_to": 0,
  • "approver_name": "string",
  • "approver_email": "string",
  • "transfer_item_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Read receive item

path Parameters
id
required
integer

Receive Item ID

query Parameters
with_archives
boolean
Default: true
with_origin
boolean
Default: true
includes
string
Example: includes=from_warehouse;warehouse;items.item;form.createdBy;form.requestApprovalTo;form.branch;transfer_item.form;transfer_item.items;

multi value, divide with coma (;)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update receive item

path Parameters
id
required
integer

Receive Item ID

Request Body schema: application/json
id
integer
increment_group
string
date
date
warehouse_id
integer
from_warehouse_id
integer
from_warehouse_name
string
notes
string
Array of objects
request_approval_to
integer
approver_name
string
approver_email
string
transfer_item_id
integer
transfer_item_form_number
string
created_by
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "increment_group": "string",
  • "date": null,
  • "warehouse_id": 0,
  • "from_warehouse_id": 0,
  • "from_warehouse_name": "string",
  • "notes": "string",
  • "items": [
    ],
  • "request_approval_to": 0,
  • "approver_name": "string",
  • "approver_email": "string",
  • "transfer_item_id": 0,
  • "transfer_item_form_number": "string",
  • "created_by": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete receive item

path Parameters
id
required
integer

Receive Item ID

Request Body schema: application/json
reason
string

Responses

Request samples

Content type
application/json
{
  • "reason": "string"
}

Export receive items

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "url": "string"
}

Inventory Usage

inventory usage - create

Request Body schema: application/json
object (inventory-usage-original-data)
required
Array of objects
increment_group
string
date
string
warehouse_id
required
integer
warehouse_name
string
employee_id
required
integer
employee_name
string
request_approval_to
required
string
approver_name
string
approver_email
string
notes
string
object

Responses

Request samples

Content type
application/json
{
  • "originalData": {
    },
  • "increment_group": "202210",
  • "date": "2022-10-07 13:51:46",
  • "warehouse_id": 1,
  • "warehouse_name": "CENTRAL WAREHOUSE",
  • "employee_id": 1,
  • "employee_name": "Jhon Doe",
  • "request_approval_to": 1,
  • "approver_name": "admin admin",
  • "approver_email": "rockydocky007@yahoo.com",
  • "notes": null,
  • "items": [
    ],
  • "errors": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

inventory usage - all

query Parameters
join
string
Example: join=form,warehouse,items,item
fields
string
Example: fields=inventory_usage.*
sort_by
string
Example: sort_by=-form.number
filter_form
string
Example: filter_form=notArchived;null
filter_like
string
Example: filter_like={}
filter_date_min
string
Example: filter_date_min={"form.date":"2022-10-01+00:00:00"}
filter_date_max
string
Example: filter_date_max={"form.date":"2022-10-07+23:59:59"}
limit
integer
Example: limit=10
includes
string
Example: includes=form;warehouse;items;items.item
page
integer
Example: page=1

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {}
}

inventory usage - histories

query Parameters
sort_by
string
Example: sort_by=-user_activities.date
includes
string
Example: includes=user
filter_like
string
Example: filter_like={}
or_filter_where_has_like[]
string
Example: or_filter_where_has_like[]={"user":{}}
limit
integer
Example: limit=10
page
integer
Example: page=1

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {}
}

inventory usage - approve

path Parameters
id
required
string
Example: 46
Request Body schema: application/json
id
required
integer

Responses

Request samples

Content type
application/json
{
  • "id": "46"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

inventory usage - reject

path Parameters
id
required
string
Example: 47
Request Body schema: application/json
id
required
integer
reason
required
string

Responses

Request samples

Content type
application/json
{
  • "id": 47,
  • "reason": "reject with note"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Cash Advance

Read all cash advances

Authorizations:
None
query Parameters
join
string
Example: join=form,details,account,employee
sort_by
string
Example: sort_by=-form.number
group_by
string
Example: group_by=cash_advance.id
fields
string
Example: fields=cash_advance.*
filter_form
string
Example: filter_form=notArchived;null
filter_like
string
Example: filter_like={}
filter_date_min
string
Example: filter_date_min={"form.date":"20220501 00:00:00"}
filter_date_max
string
Example: filter_date_max={"form.date":"20220514 23:59:59"}
limit
integer
Example: limit=10
includes
string
Example: includes=employee;form;details.account;
page
integer
Example: page=1

Responses

Response samples

Content type
application/json
{
  • "links": {
    },
  • "meta": {
    },
  • "data": [
    ]
}

Create new cash advance

Authorizations:
None
Request Body schema: multipart/form-data
increment_group
integer
date
string
payment_type
string
employee_id
integer
employee_name
string
request_approval_to
integer
approver_name
string
approver_email
string
amount
integer
notes
string
activity
string
details[0][chart_of_account_id]
integer
details[0][chart_of_account_name]
string
details[0][amount]
integer
details[0][notes]
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Read cash advance

Authorizations:
None
query Parameters
includes
string
Example: includes=employee;form;details.account;form.requestApprovalTo;form.branch

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update cash advance

Authorizations:
None
Request Body schema: application/x-www-form-urlencoded
id
integer
increment_group
integer
date
string
number
string
payment_type
string
employee_id
integer
employee_name
string
request_approval_to
integer
approver_name
string
approver_email
string
amount
integer
notes
string
activity
string
details[0][chart_of_account_id]
integer
details[0][chart_of_account_name]
string
details[0][amount]
integer
details[0][notes]
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Request cancellation cash advance

Authorizations:
None
query Parameters
id
integer
Example: id=7
reason
string
Example: reason=reason
activity
string
Example: activity=Request Cancellation Form

Responses

Cancellation approve cash advance

Authorizations:
None
Request Body schema: multipart/form-data
id
integer
activity
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Cancellation reject cash advance

Authorizations:
None
Request Body schema: multipart/form-data
id
integer
activity
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Send bulk approval cash advance via email

Authorizations:
None
header Parameters
Tenant
string
Example: dev
Request Body schema: multipart/form-data
bulk_id
Array of integers
tenant_url
string
activity
string

Responses

Approve cash advance by email

Authorizations:
None
Request Body schema: multipart/form-data
token
string
id
integer
status
string
activity
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Bulk approve cash advance by email

Authorizations:
None
Request Body schema: multipart/form-data
token
string
bulk_id
Array of integers
status
string
activity
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Approve cash advance

Authorizations:
None
Request Body schema: multipart/form-data
id
integer
activity
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Reject cash advance

Authorizations:
None
Request Body schema: multipart/form-data
id
integer
activity
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Read all history cash advance

Authorizations:
None
query Parameters
group_by
string
Example: group_by=user_activity.id
fields
string
Example: fields=user_activity.*
limit
integer
Example: limit=10
page
integer
Example: page=1
sort_by
string
Example: sort_by=-date
filter_like
string
Example: filter_like={}
includes
string
Example: includes=user;table.employee;table.form;table.details.account;
filter_equal
string
Example: filter_equal={"number":"CA22050005"}

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Create history cash advance

Authorizations:
None
Request Body schema: multipart/form-data
id
integer
activity
string

Responses

Refund cash advance

Authorizations:
None
Request Body schema: multipart/form-data
id
integer
activity
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Cash / Bank Report

Get Reports

Authorizations:
None
query Parameters
filter_form
string
Example: filter_form=notArchived;null
filter_date_min
string
Example: filter_date_min={"form.date":"2022-05-01 00:00:00"}
filter_date_max
string
Example: filter_date_max={"form.date":"2022-05-29 23:59:59"}
report_type
string
Example: report_type=cash
report_name
string
Example: report_name=CashReport
limit
integer
Example: limit=1000

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "opening_balance": {
    },
  • "total": {
    },
  • "ending_balance": 0,
  • "cash_advance": 0
}

Set Checklist Record

Authorizations:
None
Request Body schema: multipart/form-data
number
string
report_name
string
is_checked
integer

Responses

Response samples

Content type
application/json
{
  • "number": "string",
  • "feature": "string",
  • "is_checked": "string",
  • "updated_at": "string",
  • "created_at": "string",
  • "id": 0
}

Delivery Order

delivery order - all

query Parameters
join
string
Example: join=form,customer,items,item
fields
string
Example: fields=sales_delivery_order.*
sort_by
string
Example: sort_by=-form.number
group_by
string
Example: group_by=form.id
filter_form
string
Example: filter_form=notArchived;null
filter_like
string
Example: filter_like={}
filter_date_min
string
Example: filter_date_min={"form.date":"2022-05-01 00:00:00"}
filter_date_max
string
Example: filter_date_max={"form.date":"2022-06-08 23:59:59"}
limit
integer
Example: limit=10
includes
string
Example: includes=form;customer;warehouse;items.item;items.allocation
page
integer
Example: page=1

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {}
}

delivery order - create

Request Body schema: application/json
object (original-data)
required
Array of objects
need_down_payment
string
cash_only
string
notes
string
discount_percent
string
discount_value
string
type_of_tax
string
request_approval_at
string
increment_group
string
date
string
warehouse_id
required
integer
warehouse_name
string
customer_id
required
integer
customer_name
string
customer_label
string
customer_address
string
customer_phone
string
customer_email
string
pricing_group_id
integer
request_approval_to
required
string
approver_name
string
approver_email
string
sales_order_id
required
integer
object

Responses

Request samples

Content type
application/json
{
  • "originalData": {
    },
  • "increment_group": "202206",
  • "date": "2022-06-07 22:05:04",
  • "warehouse_id": 2,
  • "warehouse_name": "Hanna Schuster",
  • "customer_id": 12,
  • "customer_name": "PINNAPLE",
  • "customer_label": "[CUST-002] PINNAPLE",
  • "customer_address": null,
  • "customer_phone": null,
  • "customer_email": null,
  • "pricing_group_id": 1,
  • "need_down_payment": 0,
  • "cash_only": false,
  • "notes": null,
  • "discount_percent": 0,
  • "discount_value": 0,
  • "type_of_tax": "exclude",
  • "items": [
    ],
  • "request_approval_to": 1,
  • "request_approval_at": "2022-06-07 22:05:04",
  • "approver_name": "admin admin",
  • "approver_email": "aininr13@gmail.com",
  • "sales_order_id": 18,
  • "errors": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

delivery order - export

query Parameters
join
string
Example: join= form,customer,items,item
fields
string
Example: fields= sales_delivery_order.*;sales_delivery_order_item.*
sort_by
string
Example: sort_by= -form.number
filter_form
string
Example: filter_form= notArchived;null
filter_like
string
Example: filter_like= {}
filter_date_min
string
Example: filter_date_min= {"form.date":"2022-06-01 00:00:00"}
filter_date_max
string
Example: filter_date_max= {"form.date":"2022-06-07 23:59:59"}
includes
string
Example: includes= form;customer;warehouse;items.item

Responses

Response samples

Content type
application/json
{}

delivery order - all approval

query Parameters
join
string
Example: join=form,customer,items,item
fields
string
Example: fields=sales_delivery_order.*
sort_by
string
Example: sort_by=-form.number
group_by
string
Example: group_by=form.id
filter_form
string
Example: filter_form=notArchived;null
filter_like
string
Example: filter_like={}
filter_date_min
string
Example: filter_date_min={"form.date":"2022-05-01 00:00:00"}
filter_date_max
string
Example: filter_date_max={"form.date":"2022-05-17 23:59:59"}
limit
integer
Example: limit=10
includes
string
Example: includes=form;customer;warehouse;items.item;items.allocation
page
integer
Example: page=1

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {}
}

delivery order - show

path Parameters
id
required
any

delivery order id

query Parameters
with_archives
boolean
Example: with_archives=true
with_origin
boolean
Example: with_origin=true
includes
string
Example: includes=customer;warehouse;items.item;items.allocation;salesOrder.form;form.createdBy;form.requestApprovalTo;form.branch

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

delivery order - update

path Parameters
id
required
string
Example: 59
Request Body schema: application/json
object
id
integer
required
Array of objects
increment_group
string
date
required
string
warehouse_id
required
integer
warehouse_name
string
customer_id
required
integer
customer_name
string
customer_label
string
customer_address
string
customer_phone
string
customer_email
string
pricing_group_id
integer
request_approval_to
required
string
approver_name
string
approver_email
string
sales_order_id
required
integer
object

Responses

Request samples

Content type
application/json
{
  • "originalData": {
    },
  • "id": 66,
  • "increment_group": "202206",
  • "date": "2022-06-04 12:56:26",
  • "warehouse_id": 2,
  • "warehouse_name": "Hanna Schuster",
  • "customer_id": 11,
  • "customer_name": "AINI",
  • "customer_label": "[CUST-0123] AINI",
  • "customer_address": null,
  • "customer_phone": null,
  • "customer_email": null,
  • "pricing_group_id": 1,
  • "items": [
    ],
  • "request_approval_to": 1,
  • "approver_name": "admin admin",
  • "approver_email": "aininr13@gmail.com",
  • "sales_order_id": 12,
  • "errors": {
    }
}

Response samples

Content type
application/json
{
  • "warehouse_id": 2,
  • "customer_id": 11,
  • "customer_name": "AINI",
  • "customer_address": null,
  • "customer_phone": null,
  • "sales_order_id": 12,
  • "id": 69,
  • "sales_order": {
    },
  • "form": {
    },
  • "customer": {
    },
  • "items": [
    ]
}

delivery order - cancel

path Parameters
id
required
any

delivery order id

Request Body schema: application/json
reason
required
string

Responses

Request samples

Content type
application/json
{
  • "reason": "string"
}

delivery order - show histories

path Parameters
id
required
string
Example: 66
query Parameters
sort_by
string
Example: sort_by=-user_activities.date
includes
string
Example: includes=user
filter_like
string
Example: filter_like={}
or_filter_where_has_like[]
string
Example: or_filter_where_has_like[]={"user":{}}
limit
integer
Example: limit=10
page
integer
Example: page=1

Responses

Response samples

Content type
application/json
{}

delivery order - create history

path Parameters
id
required
any
Request Body schema: application/json
id
required
integer
activity
required
string

Responses

Request samples

Content type
application/json
{
  • "id": 66,
  • "activity": "Printed"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

delivery order - approve

path Parameters
id
required
string
Example: 66
Request Body schema: application/json
id
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "66"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

delivery order - reject

path Parameters
id
required
string
Example: 69
Request Body schema: application/json
id
required
string
reason
required
string

Responses

Request samples

Content type
application/json
{
  • "id": 69,
  • "reason": "reason delivery order rejected"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

delivery order - cancel approve

path Parameters
id
required
string
Example: 69
Request Body schema: application/json
id
required
integer

Responses

Request samples

Content type
application/json
{
  • "id": 69
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

delivery order - cancel reject

path Parameters
id
required
string
Example: 67
Request Body schema: application/json
id
required
integer
reason
required
string

Responses

Request samples

Content type
application/json
{
  • "id": 67,
  • "reason": "cancellation reject reason"
}

Response samples

Content type
application/json
{
  • "id": 67,
  • "customer_id": 12,
  • "warehouse_id": 2,
  • "sales_order_id": 18,
  • "customer_name": "PINNAPLE",
  • "customer_address": null,
  • "customer_phone": null,
  • "billing_address": null,
  • "billing_phone": null,
  • "billing_email": null,
  • "shipping_address": null,
  • "shipping_phone": null,
  • "shipping_email": null,
  • "form": {
    },
  • "delivery_notes": [ ]
}

delivery order - close

path Parameters
id
required
string
Example: 59
Request Body schema: application/json
reason
required
string

Responses

Request samples

Content type
application/json
{
  • "id": 59,
  • "reason": "close reason"
}

delivery order - close approve

path Parameters
id
required
string
Example: 59
Request Body schema: application/json
id
required
string

Responses

Request samples

Content type
application/json
{
  • "id": 59
}

Response samples

Content type
application/json
{
  • "id": 59,
  • "customer_id": 11,
  • "warehouse_id": 2,
  • "sales_order_id": 23,
  • "customer_name": "AINI",
  • "customer_address": null,
  • "customer_phone": null,
  • "billing_address": null,
  • "billing_phone": null,
  • "billing_email": null,
  • "shipping_address": null,
  • "shipping_phone": null,
  • "shipping_email": null,
  • "form": {
    },
  • "sales_order": {
    }
}

delivery order - close reject

path Parameters
id
required
string
Example: 57
Request Body schema: application/json
id
required
string

Responses

Request samples

Content type
application/json
{
  • "id": 57,
  • "reason": "close reject reason"
}

Response samples

Content type
application/json
{
  • "id": 57,
  • "customer_id": 12,
  • "warehouse_id": 2,
  • "sales_order_id": 25,
  • "customer_name": "PINNAPLE",
  • "customer_address": null,
  • "customer_phone": null,
  • "billing_address": null,
  • "billing_phone": null,
  • "billing_email": null,
  • "shipping_address": null,
  • "shipping_phone": null,
  • "shipping_email": null,
  • "form": {
    }
}

delivery order - send approval email

Request Body schema: application/json
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

delivery order - approve by email

Request Body schema: application/json
ids
required
Array of integers
token
required
string
approver_id
required
string

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "token": "1d3c927edc7339345ee77fd64e9beeba",
  • "approver_id": "1"
}

Delivery Note

delivery note - all

query Parameters
join
string
Example: join=form,customer,items,item
fields
string
Example: fields=sales_delivery_order.*
sort_by
string
Example: sort_by=-form.number
group_by
string
Example: group_by=form.id
filter_form
string
Example: filter_form=notArchived;null
filter_like
string
Example: filter_like={}
filter_date_min
string
Example: filter_date_min={"form.date":"2022-05-01 00:00:00"}
filter_date_max
string
Example: filter_date_max={"form.date":"2022-06-08 23:59:59"}
limit
integer
Example: limit=10
includes
string
Example: includes=form;customer;warehouse;items.item;items.allocation
page
integer
Example: page=1

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {}
}

delivery note - create

Request Body schema: application/json
object
cash_only
integer
customer_address
string
customer_email
string
customer_id
required
integer
customer_label
string
customer_name
string
customer_phone
string
date
string
delivery_order_item_id
integer
discount_percent
string
discount_value
string
driver
string
license_plate
string
increment_group
string
items
required
object
need_down_payment
integer
notes
string
pricing_group_id
integer
tax
integer
tax_base
integer
type_of_tax
string
warehouse_id
required
integer
warehouse_name
string
object

Responses

Request samples

Content type
application/json
{
  • "originalData": {
    },
  • "cash_only": false,
  • "customer_address": null,
  • "customer_email": null,
  • "customer_id": 1,
  • "customer_label": "[Cust 001] Customer 001",
  • "customer_name": "Customer 001",
  • "customer_phone": null,
  • "date": "2022-07-26 07:06:22",
  • "delivery_order_id": 2,
  • "discount_percent": 0,
  • "discount_value": 0,
  • "driver": "asdad",
  • "license_plate": "asdasd",
  • "increment_group": "202207",
  • "need_down_payment": 0,
  • "notes": null,
  • "pricing_group_id": 1,
  • "request_approval_to": 1,
  • "type_of_tax": "exclude",
  • "warehouse_id": 2,
  • "warehouse_name": "Local House",
  • "items": [
    ],
  • "errors": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

delivery note - show

path Parameters
id
required
any

delivery note id

query Parameters
with_archives
boolean
Example: with_archives=true
with_origin
boolean
Example: with_origin=true
includes
string
Example: includes=customer;warehouse;items.item;items.allocation;form.createdBy;form.requestApprovalTo;form.branch

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

delivery note - update

path Parameters
id
required
string
Example: 59
Request Body schema: application/json
object
cash_only
integer
customer_address
string
customer_email
string
customer_id
required
integer
customer_label
string
customer_name
string
customer_phone
string
date
string
delivery_order_item_id
integer
discount_percent
string
discount_value
string
driver
string
license_plate
string
increment_group
string
items
required
object
need_down_payment
integer
notes
string
pricing_group_id
integer
tax
integer
tax_base
integer
type_of_tax
string
warehouse_id
required
integer
warehouse_name
string

Responses

Request samples

Content type
application/json
{
  • "originalData": {
    },
  • "cash_only": false,
  • "customer_address": null,
  • "customer_email": null,
  • "customer_id": 1,
  • "customer_label": "[Cust 001] Customer 001",
  • "customer_name": "Customer 001",
  • "customer_phone": null,
  • "date": "2022-07-26 07:06:22",
  • "delivery_order_id": 2,
  • "discount_percent": 0,
  • "discount_value": 0,
  • "driver": "asdad",
  • "license_plate": "asdasd",
  • "increment_group": "202207",
  • "need_down_payment": 0,
  • "notes": null,
  • "pricing_group_id": 1,
  • "request_approval_to": 1,
  • "type_of_tax": "exclude",
  • "warehouse_id": 2,
  • "warehouse_name": "Local House",
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

delivery Note - cancel

path Parameters
id
required
any

delivery note id

Request Body schema: application/json
reason
required
string

Responses

Request samples

Content type
application/json
{
  • "reason": "string"
}

delivery note - approve

path Parameters
id
required
string
Example: 66

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

delivery note - reject

path Parameters
id
required
string
Example: 69
Request Body schema: application/json
reason
required
string

Responses

Request samples

Content type
application/json
{
  • "reason": "reason delivery note rejected"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

delivery note - cancel approve

path Parameters
id
required
string
Example: 66

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

delivery note - cancel reject

path Parameters
id
required
string
Example: 69
Request Body schema: application/json
reason
required
string

Responses

Request samples

Content type
application/json
{
  • "reason": "cancellation reject reason"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

delivery note - show histories

path Parameters
id
required
string
Example: 66
query Parameters
sort_by
string
Example: sort_by=-user_activities.date
includes
string
Example: includes=user
filter_like
string
Example: filter_like={}
or_filter_where_has_like[]
string
Example: or_filter_where_has_like[]={"user":{}}
limit
integer
Example: limit=10
page
integer
Example: page=1

Responses

Response samples

Content type
application/json
{}

delivery note - create history

path Parameters
id
required
any
Request Body schema: application/json
id
required
integer
activity
required
string

Responses

Request samples

Content type
application/json
{
  • "id": 66,
  • "activity": "Printed"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

delivery note - export

query Parameters
join
string
Example: join= form,customer,items,item
fields
string
Example: fields= sales_delivery_note.*;sales_delivery_note_item.*
sort_by
string
Example: sort_by= -form.number
filter_form
string
Example: filter_form= notArchived;null
filter_like
string
Example: filter_like= {}
filter_date_min
string
Example: filter_date_min= {"form.date":"2022-06-01 00:00:00"}
filter_date_max
string
Example: filter_date_max= {"form.date":"2022-06-07 23:59:59"}
includes
string
Example: includes= form;customer;warehouse;items.item

Responses

Response samples

Content type
application/json
{}

Memo Journal

Read all Memo Journals

query Parameters
join
string
Example: join=form,items

multi value, divide with coma (,)

fields
string
Example: fields=memo_journal.*

multi value, divide with coma (,)

sort_by
string
Default: "name"
Example: sort_by=-form.number

Sort the result by a key

group_by
string
Example: group_by=-form.id

Group the result by a key

object
object
object
limit
integer
Example: limit=10

Data limit

includes
string
Example: includes=form;items.chart_of_account;items.form;items.masterable

multi value, divide with coma (,)

page
integer
Example: page=1

Data page

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "links": {
    },
  • "data": [
    ]
}

Create new Memo Journal

Request Body schema: application/json
increment_group
string
date
date
notes
string
Array of objects
request_approval_to
integer
approver_name
string
approver_email
string

Responses

Request samples

Content type
application/json
{
  • "increment_group": "string",
  • "date": null,
  • "notes": "string",
  • "items": [
    ],
  • "request_approval_to": 0,
  • "approver_name": "string",
  • "approver_email": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Read memo journal

path Parameters
id
required
integer

Memo Journal ID

query Parameters
with_archives
boolean
Default: true
with_origin
boolean
Default: true
includes
string
Example: includes=items.chart_of_account;items.form;items.masterable;form.createdBy;form.requestApprovalTo;form.branch;

multi value, divide with coma (;)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update memo journal

path Parameters
id
required
integer

Memo Journal ID

Request Body schema: application/json
old_id
integer
increment_group
string
date
date
notes
string
Array of objects
request_approval_to
integer
approver_name
string
approver_email
string

Responses

Request samples

Content type
application/json
{
  • "old_id": 0,
  • "increment_group": "string",
  • "date": null,
  • "notes": "string",
  • "items": [
    ],
  • "request_approval_to": 0,
  • "approver_name": "string",
  • "approver_email": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete memo journal

path Parameters
id
required
integer

Memo Journal ID

Request Body schema: application/json
reason
string

Responses

Request samples

Content type
application/json
{
  • "reason": "string"
}

Export memo journals

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "url": "string"
}

Payment Collection

payment collection - all

query Parameters
join
string
Example: join=formcustomer
fields
string
Example: fields=sales_payment_collection.*
sort_by
string
Example: sort_by=-form.number
group_by
string
Example: group_by=form.id
filter_form
string
Example: filter_form=notArchived;null
filter_like
string
Example: filter_like={}
filter_date_min
string
Example: filter_date_min={form.date:2022-05-01 00:00:00}
filter_date_max
string
Example: filter_date_max={form.date:2022-06-08 23:59:59}
limit
integer
Example: limit=10
includes
string
Example: includes=form;customer;details;details.referenceable;details.referenceable.form
page
integer
Example: page=1

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {}
}

payment collection - create

Request Body schema: application/json
originalData
any (payment-collection-original-data)
customer_id
required
integer
customer_name
string
customer_label
string
customer_address
string
customer_phone
string
increment_group
string
date
string
due_date
string
payment_type
required
string
request_approval_to
required
integer
approver_name
string
approver_email
string
notes
string
amount
integer
total_invoice
integer
total_down_payment
integer
total_return
integer
total_other
integer
total_amount
integer
pricing_group_id
integer
Array of objects
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "originalData": {
    },
  • "customer_id": 4,
  • "customer_name": "CUSTOMER TEST MIRNA",
  • "customer_label": "[003] CUSTOMER TEST MIRNA",
  • "customer_address": "JALAN MUSI 21",
  • "customer_phone": "087851858365",
  • "increment_group": "202208",
  • "date": "2022-08-01 01:11:12",
  • "due_date": "2022-08-01 01:11:12",
  • "payment_type": "cash",
  • "request_approval_to": 1,
  • "approver_name": "admin admin",
  • "approver_email": "admin@point.com",
  • "notes": "notes",
  • "amount": 36760,
  • "total_invoice": 0,
  • "total_down_payment": 0,
  • "total_return": 0,
  • "total_other": 30000,
  • "total_amount": 0,
  • "details": [
    ],
  • "errors": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

payment collection - export

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{}

payment collection - all approval

query Parameters
limit
integer
Example: limit=10
page
integer
Example: page=1

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

payment collection - show

path Parameters
id
required
any

payment collection id

query Parameters
with_archives
boolean
Example: with_archives=true
with_origin
boolean
Example: with_origin=true
includes
string
Example: includes=form;customer;details;details.chartOfAccount;details.chartOfAccount.type;details.allocation;form.createdBy;form.requestApprovalTo;form.branch

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

payment collection - update

path Parameters
id
required
string
Example: 59
Request Body schema: application/json
originalData
any
required
Array of objects
customer_id
required
integer
customer_name
string
customer_label
string
customer_address
string
customer_phone
string
increment_group
string
date
string
due_date
string
payment_type
required
string
request_approval_to
required
integer
approver_name
string
approver_email
string
notes
string
amount
integer
total_invoice
integer
total_down_payment
integer
total_return
integer
total_other
integer
total_amount
integer
pricing_group_id
integer
Array of objects

Responses

Request samples

Content type
application/json
{
  • "customer_id": 4,
  • "customer_name": "CUSTOMER TEST MIRNA",
  • "customer_label": "[003] CUSTOMER TEST MIRNA",
  • "customer_address": "JALAN MUSI 21",
  • "customer_phone": "087851858365",
  • "increment_group": "202208",
  • "date": "2022-08-01 01:11:12",
  • "due_date": "2022-08-01 01:11:12",
  • "payment_type": "cash",
  • "request_approval_to": 1,
  • "approver_name": "admin admin",
  • "approver_email": "admin@point.com",
  • "notes": "notes",
  • "amount": 36760,
  • "total_invoice": 0,
  • "total_down_payment": 0,
  • "total_return": 0,
  • "total_other": 30000,
  • "total_amount": 0,
  • "details": [
    ],
  • "errors": {
    }
}

Response samples

Content type
application/json
{
  • "customer_id": 4,
  • "customer_name": "CUSTOMER TEST MIRNA",
  • "due_date": "2022-08-01 02:02:31",
  • "payment_type": "cash",
  • "amount": 56760,
  • "id": 89,
  • "form": {
    }
}

payment collection - cancel

path Parameters
id
required
any

payment collection id

Request Body schema: application/json
reason
required
string

Responses

Request samples

Content type
application/json
{
  • "reason": "string"
}

payment collection - show histories

path Parameters
id
required
string
Example: 66
query Parameters
sort_by
string
Example: sort_by=-user_activities.date
includes
string
Example: includes=user
filter_like
string
Example: filter_like={}
or_filter_where_has_like[]
string
Example: or_filter_where_has_like[]={user:{}}
limit
integer
Example: limit=10
page
integer
Example: page=1

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

payment collection - create history

path Parameters
id
required
any
Request Body schema: application/json
id
required
integer
activity
required
string

Responses

Request samples

Content type
application/json
{
  • "id": 66,
  • "activity": "Approved"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

payment collection - approve

path Parameters
id
required
string
Example: 79
Request Body schema: application/json
id
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "79"
}

Response samples

Content type
application/json
{
  • "id": 79,
  • "payment_type": "cash",
  • "due_date": "2022-07-21 22:00:24",
  • "payment_account_id": null,
  • "amount": 33000,
  • "supplier_id": 0,
  • "supplier_name": null,
  • "payment_id": null,
  • "customer_id": 2,
  • "customer_name": "CUSTOMER 2",
  • "details": [
    ],
  • "form": {
    }
}

payment collection - reject

path Parameters
id
required
string
Example: 69
Request Body schema: application/json
id
required
string
reason
required
string

Responses

Request samples

Content type
application/json
{
  • "id": 69,
  • "reason": "payment collection rejected"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

payment collection - cancel approve

path Parameters
id
required
string
Example: 69
Request Body schema: application/json
id
required
integer

Responses

Request samples

Content type
application/json
{
  • "id": 69
}

Response samples

Content type
application/json
{
  • "id": 88,
  • "payment_type": "bank",
  • "due_date": "2022-08-01 07:56:44",
  • "payment_account_id": null,
  • "amount": 43000,
  • "supplier_id": 0,
  • "supplier_name": null,
  • "payment_id": null,
  • "customer_id": 2,
  • "customer_name": "CUSTOMER 2",
  • "form": {
    }
}

payment collection - cancel reject

path Parameters
id
required
string
Example: 67
Request Body schema: application/json
id
required
integer
reason
required
string

Responses

Request samples

Content type
application/json
{
  • "id": 67,
  • "reason": "cancellation reject reason"
}

Response samples

Content type
application/json
{
  • "id": 67,
  • "payment_type": "bank",
  • "due_date": "2022-08-01 07:56:44",
  • "payment_account_id": null,
  • "amount": 43000,
  • "supplier_id": 0,
  • "supplier_name": "",
  • "payment_id": null,
  • "customer_id": 2,
  • "customer_name": "CUSTOMER 2",
  • "form": {
    }
}

payment collection - send approval email

Request Body schema: application/json
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

payment collection - approve by email

Request Body schema: application/json
ids
required
Array of integers
token
required
string
approver_id
required
string

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "token": "1d3c927edc7339345ee77fd64e9beeba",
  • "approver_id": "1"
}

payment collection - get references

path Parameters
customer_id
required
integer
Example: 2

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Sales Return

sales return - all

query Parameters
join
string
Example: join=form,customer,items,item
fields
string
Example: fields=sales_return.*
sort_by
string
Example: sort_by=-form.number
group_by
string
Example: group_by=form.id
filter_form
string
Example: filter_form=notArchived;null
filter_like
string
Example: filter_like={}
filter_date_min
string
Example: filter_date_min={"form.date":"2022-05-01 00:00:00"}
filter_date_max
string
Example: filter_date_max={"form.date":"2022-06-08 23:59:59"}
limit
integer
Example: limit=10
includes
string
Example: includes=form;customer;items.item;items.allocation
page
integer
Example: page=1

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {}
}

sales return - create

Request Body schema: application/json
object (sales-return-original-data)
required
Array of objects
request_approval_at
string
increment_group
string
date
string
warehouse_id
required
integer
customer_id
required
integer
customer_name
string
customer_label
string
customer_address
string
customer_phone
string
customer_email
string
request_approval_to
required
string
approver_name
string
approver_email
string
sales_invoice_id
required
integer
type_of_tax
required
string
sub_total
required
integer
tax_base
required
integer
tax
required
integer
amount
required
integer
object

Responses

Request samples

Content type
application/json
{
  • "originalData": {
    },
  • "increment_group": "202209",
  • "date": "2022-09-11 12:36:14",
  • "amount": 5500,
  • "approver_email": "admin@point.com",
  • "approver_name": "admin admin",
  • "customer_address": null,
  • "customer_email": null,
  • "customer_id": 1,
  • "customer_name": "Customer",
  • "customer_phone": null,
  • "request_approval_to": 1,
  • "sales_invoice_id": 33,
  • "tax": 500,
  • "type_of_tax": "exclude",
  • "warehouse_id": 1,
  • "notes": "rusak",
  • "items": [
    ],
  • "errors": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

sales return - all approval

query Parameters
join
string
Example: join=form,customer,items,item
fields
string
Example: fields=sales_return.*
sort_by
string
Example: sort_by=-form.number
group_by
string
Example: group_by=form.id
filter_form
string
Example: filter_form=notArchived;null
filter_like
string
Example: filter_like={}
filter_date_min
string
Example: filter_date_min={"form.date":"2022-05-01 00:00:00"}
filter_date_max
string
Example: filter_date_max={"form.date":"2022-05-17 23:59:59"}
limit
integer
Example: limit=10
includes
string
Example: includes=form;customer;items.item;items.allocation
page
integer
Example: page=1

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {}
}

sales return - show

path Parameters
id
required
any

sales return id

query Parameters
with_archives
boolean
Example: with_archives=true
with_origin
boolean
Example: with_origin=true
includes
string
Example: includes=customer;items.item;items.allocation;salesInvoice.form;form.createdBy;form.requestApprovalTo;form.branch

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

sales return - update

path Parameters
id
required
string
Example: 59
Request Body schema: application/json
originalData
any
required
Array of objects
request_approval_at
string
increment_group
string
date
string
warehouse_id
required
integer
customer_id
required
integer
customer_name
string
customer_label
string
customer_address
string
customer_phone
string
customer_email
string
request_approval_to
required
string
approver_name
string
approver_email
string
sales_invoice_id
required
integer
type_of_tax
required
string
sub_total
required
integer
tax_base
required
integer
tax
required
integer
amount
required
integer
object

Responses

Request samples

Content type
application/json
{
  • "originalData": {
    },
  • "increment_group": "202209",
  • "date": "2022-09-11 12:36:14",
  • "amount": 5500,
  • "approver_email": "admin@point.com",
  • "approver_name": "admin admin",
  • "customer_address": null,
  • "customer_email": null,
  • "customer_id": 1,
  • "customer_name": "Customer",
  • "customer_phone": null,
  • "request_approval_to": 1,
  • "sales_invoice_id": 33,
  • "tax": 500,
  • "type_of_tax": "exclude",
  • "warehouse_id": 1,
  • "notes": "rusak",
  • "items": [
    ],
  • "errors": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

sales return - delete

path Parameters
id
required
string
Example: 59

Responses

sales return - show histories

path Parameters
id
required
string
Example: 16
query Parameters
sort_by
string
Example: sort_by=-user_activities.date
includes
string
Example: includes=user
filter_like
string
Example: filter_like={}
or_filter_where_has_like[]
string
Example: or_filter_where_has_like[]={"user":{}}
limit
integer
Example: limit=10
page
integer
Example: page=1

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {}
}

sales return - approve

path Parameters
id
required
string
Example: 14
Request Body schema: application/json
id
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "14"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

sales return - reject

path Parameters
id
required
string
Example: 16
Request Body schema: application/json
id
required
string
reason
required
string

Responses

Request samples

Content type
application/json
{
  • "id": 16,
  • "reason": "reason sales return rejected"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

sales return - cancel approve

path Parameters
id
required
string
Example: 16
Request Body schema: application/json
id
required
integer

Responses

Request samples

Content type
application/json
{
  • "id": 16
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

sales return - cancel reject

path Parameters
id
required
string
Example: 16
Request Body schema: application/json
id
required
integer
reason
required
string

Responses

Request samples

Content type
application/json
{
  • "id": 16,
  • "reason": "cancellation reject reason"
}

Response samples

Content type
application/json
null

sales return - send approval email

Request Body schema: application/json
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

sales return - approve by email

Request Body schema: application/json
ids
required
Array of integers
token
required
string
approver_id
required
string

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "token": "4a004ce7706e2d35555ce75898bc3f0b",
  • "approver_id": "1"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Employee

Employee - All

query Parameters
sort_by
string
Example: sort_by=name
filter_like
string
Example: name=john
limit
integer
Example: limit=10
page
integer
Example: page=1
includes
string
Example: includes=scorers, reviewers
additional
string
Example: additional=groups
filter_status
string
Example: filter_status=1

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {}
}

Employee - Create

Request Body schema: application/json
name
required
string
tax_identification_number
string
bpjs
string
Array of objects
Array of objects
Array of objects
birth_date
date
birth_place
string
personal_identity
string
last_education
string
employee_marital_status_id
integer
marital_status
string
married_with
string
employee_group_id
integer
employee_group_name
string
job_title
string
join_date
date
resign_date
date
code
string
status
string
job_location
string
daily_transport_allowance
string
functional_allowance
string
communication_allowance
string
Array of objects
Array of objects
Array of objects
Array of objects
Array of objects
Array of objects
attachments
Array of objects
errors
Array of objects
employee_gender_id
integer
employee_religion_id
integer
employee_status_id
integer
user_id
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "tax_identification_number": "string",
  • "bpjs": "string",
  • "emails": [
    ],
  • "addresses": [
    ],
  • "phones": [
    ],
  • "birth_date": null,
  • "birth_place": "string",
  • "personal_identity": "string",
  • "last_education": "string",
  • "employee_marital_status_id": 0,
  • "marital_status": "string",
  • "married_with": "string",
  • "employee_group_id": 0,
  • "employee_group_name": "string",
  • "job_title": "string",
  • "join_date": null,
  • "resign_date": null,
  • "code": "string",
  • "status": "string",
  • "job_location": "string",
  • "daily_transport_allowance": "string",
  • "functional_allowance": "string",
  • "communication_allowance": "string",
  • "company_emails": [
    ],
  • "social_media": [
    ],
  • "contracts": [
    ],
  • "salary_histories": [
    ],
  • "scorers": [
    ],
  • "reviewers": [
    ],
  • "attachments": [
    ],
  • "errors": [
    ],
  • "employee_gender_id": 0,
  • "employee_religion_id": 0,
  • "employee_status_id": 0,
  • "user_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Employee - Detail

path Parameters
id
required
any
Example: 2

employee id

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Employee - Update

path Parameters
id
required
string
Example: 2

employee id

Request Body schema: application/json
name
required
string
tax_identification_number
string
bpjs
string
Array of objects
Array of objects
Array of objects
birth_date
date
birth_place
string
personal_identity
string
last_education
string
employee_marital_status_id
integer
marital_status
string
married_with
string
employee_group_id
integer
employee_group_name
string
job_title
string
join_date
date
resign_date
date
code
string
status
string
job_location
string
daily_transport_allowance
string
functional_allowance
string
communication_allowance
string
Array of objects
Array of objects
Array of objects
Array of objects
Array of objects
attachments
Array of objects
errors
Array of objects
employee_gender_id
integer
employee_religion_id
integer
employee_status_id
integer
user_id
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "tax_identification_number": "string",
  • "bpjs": "string",
  • "emails": [
    ],
  • "addresses": [
    ],
  • "phones": [
    ],
  • "birth_date": null,
  • "birth_place": "string",
  • "personal_identity": "string",
  • "last_education": "string",
  • "employee_marital_status_id": 0,
  • "marital_status": "string",
  • "married_with": "string",
  • "employee_group_id": 0,
  • "employee_group_name": "string",
  • "job_title": "string",
  • "join_date": null,
  • "resign_date": null,
  • "code": "string",
  • "status": "string",
  • "job_location": "string",
  • "daily_transport_allowance": "string",
  • "functional_allowance": "string",
  • "communication_allowance": "string",
  • "company_emails": [
    ],
  • "social_media": [
    ],
  • "contracts": [
    ],
  • "salary_histories": [
    ],
  • "scorers": [
    ],
  • "attachments": [
    ],
  • "errors": [
    ],
  • "employee_gender_id": 0,
  • "employee_religion_id": 0,
  • "employee_status_id": 0,
  • "user_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Employee - Delete

path Parameters
id
required
any
Example: 2

employee id

Responses

Employee Group

Employee Group - All

query Parameters
sort_by
string
Example: sort_by=name
filter_like
string
Example: name=john
limit
integer
Example: limit=10
page
integer
Example: page=1

Responses

Response samples

Content type
application/json
{}

Employee Group - Create

Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "group new"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Employee Group - Detail

path Parameters
id
required
any
Example: 2

employee group id

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Employee Group - Update

path Parameters
id
required
string
Example: 2

employee group id

Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "group update"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Employee Group - Delete

path Parameters
id
required
any
Example: 2

employee group id

Responses

Employee Job Location

Employee Job Location - All

query Parameters
sort_by
string
Example: sort_by=name
filter_like
string
Example: name=john
limit
integer
Example: limit=10
page
integer
Example: page=1

Responses

Response samples

Content type
application/json
{}

Employee Job Location - Create

Request Body schema: application/json
name
required
string
base_salary
required
string
multiplier_kpi
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "surabaya",
  • "base_salary": "4000",
  • "multiplier_kpi": "100"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Employee Job Location - Detail

path Parameters
id
required
any
Example: 2

employee job location id

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Employee Job Location - Update

path Parameters
id
required
string
Example: 2

employee job location id

Request Body schema: application/json
name
required
string
base_salary
required
string
multiplier_kpi
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "surabaya",
  • "base_salary": "4000",
  • "multiplier_kpi": "100"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Employee Job Location - Delete

path Parameters
id
required
any
Example: 2

employee job location id

Responses

Employee Status

Employee Status - All

query Parameters
sort_by
string
Example: sort_by=name
filter_like
string
Example: name=john
limit
integer
Example: limit=10
page
integer
Example: page=1

Responses

Response samples

Content type
application/json
{}

Employee Status - Create

Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "status new"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Employee Status - Detail

path Parameters
id
required
any
Example: 2

employee status id

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Employee Status - Update

path Parameters
id
required
string
Example: 2

employee status id

Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "status update"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Employee Status - Delete

path Parameters
id
required
any
Example: 2

employee status id

Responses

KPI Template

KPI Template - All

query Parameters
limit
integer
Example: limit=10
page
integer
Example: page=1

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {}
}

KPI Template - Create

Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "template"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

KPI Template - Detail

path Parameters
id
required
any
Example: 2

kpi tempalte id

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

KPI Template - Update

path Parameters
id
required
string
Example: 2

kpi tempalte id

Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "template"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

KPI Template - Delete

path Parameters
id
required
any
Example: 2

kpi tempalte id

Responses

KPI Template - Archive

path Parameters
id
required
any
Example: 2

kpi tempalte id

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

KPI Template - Activate

path Parameters
id
required
any
Example: 2

kpi tempalte id

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

KPI Template - Archive

path Parameters
id
required
any
Example: 2

kpi tempalte id

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

KPI Template - Bulk Archive

Request Body schema: application/json
templates
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "templates": "[{id:1}]"
}

KPI Template - Bulk Activate

Request Body schema: application/json
templates
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "templates": "[{id:1}]"
}

KPI Template - Duplicate

Request Body schema: application/json
kpi_template_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "kpi_template_id": "1"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

KPI Template - Copy Group

Request Body schema: application/json
group_id
required
integer
template_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "group_id": "1",
  • "template_id": "1"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

KPI Template - Export

Request Body schema: application/json
id
required
integer

Responses

Request samples

Content type
application/json
{
  • "id": "1"
}

Response samples

Content type
application/json
{}

KPI Template - Import

Request Body schema: application/json
file
required
binary

Responses

Request samples

Content type
application/json
{
  • "file": "folder-to/kpi-template.xlsx"
}

Response samples

Content type
application/json
{
  • "message": "success"
}

KPI Template Group

KPI Template Group - All

query Parameters
kpi_template_id
integer
Example: kpi_template_id=1

Responses

Response samples

Content type
application/json
{}

KPI Template Group - Create

Request Body schema: application/json
name
required
string
kpi_template_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "name": "template",
  • "kpi_template_id": 1
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

KPI Template Group - Detail

path Parameters
id
required
any
Example: 2

kpi tempalte group id

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

KPI Template Group - Update

path Parameters
id
required
string
Example: 2

kpi tempalte group id

Request Body schema: application/json
name
required
string
kpi_template_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "name": "template",
  • "kpi_template_id": 1
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

KPI Template Group - Delete

path Parameters
id
required
any
Example: 2

kpi tempalte group id

Responses

KPI Template Indicator

KPI Template Indicator - All

query Parameters
kpi_template_group_id
integer
Example: kpi_template_group_id=1

Responses

Response samples

Content type
application/json
{}

KPI Template Indicator - Create

Request Body schema: application/json
name
required
string
kpi_template_group_id
required
integer
weight
required
string
target
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "template",
  • "kpi_template_group_id": 1,
  • "weight": "100",
  • "target": "100"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

KPI Template Indicator - Detail

path Parameters
id
required
any
Example: 2

kpi tempalte indicator id

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

KPI Template Indicator - Update

path Parameters
id
required
string
Example: 2

kpi tempalte indicator id

Request Body schema: application/json
name
required
string
kpi_template_group_id
required
integer
weight
required
string
target
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "template",
  • "kpi_template_group_id": 1,
  • "weight": "100",
  • "target": "100"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

KPI Template Indicator - Delete

path Parameters
id
required
any
Example: 2

kpi tempalte indicator id

Responses

KPI Template Score

KPI Template Score - All

query Parameters
kpi_template_indicator_id
integer
Example: kpi_template_indicator_id=1

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

KPI Template Score - Create

Request Body schema: application/json
kpi_template_indicator_id
required
integer
score
string
description
string

Responses

Request samples

Content type
application/json
{
  • "kpi_template_indicator_id": 1,
  • "score": "100",
  • "description": "lorem ipsum"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

KPI Template Score - Detail

path Parameters
id
required
any
Example: 2

kpi tempalte score id

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

KPI Template Score - Update

path Parameters
id
required
string
Example: 2

kpi tempalte score id

Request Body schema: application/json
kpi_template_indicator_id
required
integer
score
string
description
string

Responses

Request samples

Content type
application/json
{
  • "kpi_template_indicator_id": 1,
  • "score": "100",
  • "description": "lorem ipsum"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

KPI Template Score - Delete

path Parameters
id
required
any
Example: 2

kpi tempalte score id

Responses

KPI Assessment

KPI Assessment - All

query Parameters
type
string
Example: type=all

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {}
}

KPI Assessment - Create

Request Body schema: application/json
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "date": {
    },
  • "template": {
    }
}

Response samples

Content type
application/json
{
  • "id": 7,
  • "name": "cuy",
  • "comment": "",
  • "date": "2022-12-26 00:00:00",
  • "employee": {
    },
  • "weight": "0.000000",
  • "target": 0,
  • "score": 0,
  • "status": "DRAFT",
  • "score_percentage": 0,
  • "scorer": {
    },
  • "groups": [
    ]
}

KPI Assessment - Detail

path Parameters
assessment-id
required
any
Example: 2

kpi assessment id

Responses

Response samples

Content type
application/json
{
  • "id": 7,
  • "name": "cuy",
  • "comment": "",
  • "date": "2022-12-26 00:00:00",
  • "employee": {
    },
  • "weight": "0.000000",
  • "target": 0,
  • "score": 0,
  • "status": "DRAFT",
  • "score_percentage": 0,
  • "scorer": {
    },
  • "groups": [
    ]
}

KPI Assessment - Update

path Parameters
assessment-id
required
string
Example: 2

kpi assessment id

Request Body schema: application/json
comment
required
string
required
object

Responses

Request samples

Content type
application/json
{
  • "comment": "lorem ipsum",
  • "template": {
    }
}

Response samples

Content type
application/json
{
  • "id": 7,
  • "name": "cuy",
  • "comment": "",
  • "date": "2022-12-26 00:00:00",
  • "employee": {
    },
  • "weight": "0.000000",
  • "target": 0,
  • "score": 0,
  • "status": "DRAFT",
  • "score_percentage": 0,
  • "scorer": {
    },
  • "groups": [
    ]
}

KPI Assessment - Delete

path Parameters
assessment-id
required
any
Example: 2

kpi assessment id

Responses

KPI Reminder

KPI Reminder

Request Body schema: application/json
to
required
string
name
required
string
employeeName
required
string
startDate
required
date
endDate
required
date

Responses

Request samples

Content type
application/json
{
  • "to": "staf-one@point.com",
  • "name": "person one",
  • "employeeName": "employee one",
  • "startDate": "2022-12-01",
  • "endDate": "2022-12-07"
}

Response samples

Content type
application/json
{
  • "message": "Success Sent KPI Reminder"
}